feat(txm): added txm callbacks and promises when tx status change by GabrielMartinezRodriguez · Pull Request #719 · HappyChainDevs/happychain

GabrielMartinezRodriguez · 2025-05-05T13:01:58Z

Linked Issues

closes https://linear.app/happychain/issue/HAPPY-496/implement-a-mechanism-to-easily-allow-txm-users-to-be-notified-when-a

Description

Implemented a simple mechanism to wait for transaction finalization in the transaction manager

Include all relevant context (but no need to repeat the issue's content).
Draw attention to new, noteworthy & unintuitive elements.

Toggle Checklist

Checklist

Basics

B1. I have applied the proper label & proper branch name (e.g. norswap/build-system-caching).
B2. This PR is not so big that it should be split & addresses only one concern.
B3. The PR targets the lowest branch it can (ideally master).

Reminder: PR review guidelines

Correctness

C1. Builds and passes tests.
C2. The code is properly parameterized & compatible with different environments (e.g. local,
testnet, mainnet, standalone wallet, ...).
C3. I have manually tested my changes & connected features.

< INDICATE BROWSER, DEMO APP & OTHER ENV DETAILS USED FOR TESTING HERE >

< INDICATE TESTED SCENARIOS (USER INTERFACE INTERACTION, CODE FLOWS) HERE >

C4. I have performed a thorough self-review of my code after submitting the PR,
and have updated the code & comments accordingly.

Architecture & Documentation

D1. I made it easy to reason locally about the code, by (1) using proper abstraction boundaries,
(2) commenting these boundaries correctly, (3) adding inline comments for context when needed.
D2. All public-facing APIs are documented in the docs.
Public APIS and meaningful (non-local) internal APIs are properly documented in code comments.
D3. If appropriate, the general architecture of the code is documented in a code comment or
in a Markdown document.
D4. An appropriate Changeset has been generated (and committed) with make changeset for
breaking and meaningful changes in packages (not required for cleanups & refactors).

cloudflare-workers-and-pages · 2025-05-05T13:02:00Z

Deploying happychain with Cloudflare Pages

Latest commit:	`e5b67a8`
Status:	✅ Deploy successful!
Preview URL:	https://9b389e5f.happychain.pages.dev
Branch Preview URL:	https://gabriel-txm-transaction-call.happychain.pages.dev

View logs

GabrielMartinezRodriguez · 2025-05-05T13:02:12Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

linear · 2025-05-05T14:14:58Z

HAPPY-496 Implement a mechanism to easily allow TXM users to be notified when a transaction changes status

Currently, it's a bit tedious for a TXM user to know when a transaction has finished. This is because the hooks are general for all transactions, not for a specific one. It might be a good idea to implement a method in the Transaction object that allows users to subscribe to specific events of that transaction.

One possible approach is to provide a callback when creating the transaction, and once the transaction is included in the TXM, collect that callback and notify the user when the transaction is updated.

The usage could be:

const tx = new Transaction(...)

tx.on("success", () => {
...
})

txm.collectTransactions([tx]);

aodhgan · 2025-05-08T17:26:33Z

packages/txm/lib/Transaction.ts

+            this.waitingPromises = []
        }

+        this.callbacks[status].forEach((callback) => callback(this))


what happens if the callback throws?

aodhgan · 2025-05-08T17:28:24Z

packages/txm/lib/Transaction.ts

+        this.callbacks[status].push(callback)
+    }
+
+    waitForFinalization(timeout?: number): Promise<Result<Transaction, Error>> {


nit: not immediately obvious this is milliseconds, maybe rename to timeoutMs or document/comment.

aodhgan · 2025-05-08T17:32:08Z

packages/txm/test/txm.test.ts


+test("Use transaction.waitForFinalization() to wait for a transaction to be finalized", async () => {
+    let promiseResolved = false
+    const transaction = await createCounterTransaction()


not urgent but createCounterTransaction should not be async

aodhgan · 2025-05-08T17:35:47Z

packages/txm/lib/Transaction.ts

+     * Stores promises that wait for the transaction to be finalized.
+     * These promises are resolved when the transaction status changes to a finalized state.
+     */
+    private waitingPromises: ((transaction: Result<Transaction, Error>) => void)[]


nit: rename to waitingFinalizedPromises

Could even be finalizedPromiseResolvers

aodhgan · 2025-05-08T17:36:38Z

packages/txm/test/txm.test.ts

+    let promiseResolved = false
+    const transaction = await createCounterTransaction()
+
+    transaction.waitForFinalization().then((result) => {


can we add a timeout test to check that that functionality works as intended?

norswap · 2025-05-16T00:58:13Z

packages/txm/lib/Transaction.ts

+        this.callbacks = Object.values(TransactionStatus).reduce(
+            (acc, status) => {
+                acc[status] = []
+                return acc
+            },
+            {} as Record<TransactionStatus, ((transaction: Transaction) => void)[]>,


Suggested change

this.callbacks = Object.values(TransactionStatus).reduce(

(acc, status) => {

acc[status] = []

return acc

},

{} as Record<TransactionStatus, ((transaction: Transaction) => void)[]>,

this.callbacks = {} as Record<TransactionStatus, ((transaction: Transaction) => void)[]>

Object.values(TransactionStatus).forEach((status) => { this.callbacks[status] = [] })

norswap · 2025-05-16T01:01:09Z

packages/txm/test/txm.test.ts

I ran stats on the repo the other day and this is the biggest file in it :D
Not important, but we can probably consider splitting it up sometime in the future.

https://linear.app/happychain/issue/HAPPY-570/split-the-txm-test-into-multiple-files

GabrielMartinezRodriguez self-assigned this May 5, 2025

GabrielMartinezRodriguez added the reviewing-1 Ready for, or undergoing first-line review label May 5, 2025

GabrielMartinezRodriguez mentioned this pull request May 5, 2025

feat(faucet): wait tx inclusion #720

Merged

11 tasks

GabrielMartinezRodriguez marked this pull request as ready for review May 5, 2025 14:12

not-reed approved these changes May 5, 2025

View reviewed changes

GabrielMartinezRodriguez force-pushed the gabriel/txm-transaction-callbacks branch from 2f78932 to 3f8de75 Compare May 6, 2025 14:03

GabrielMartinezRodriguez mentioned this pull request May 6, 2025

Faucet: Limit usage to once per time window, increase quantity, and return the remaining wait time in case of a rate limit error. #727

Merged

11 tasks

aodhgan reviewed May 8, 2025

View reviewed changes

aodhgan added reviewing-2 Ready for, or undergoing final review and removed reviewing-1 Ready for, or undergoing first-line review labels May 8, 2025

GabrielMartinezRodriguez force-pushed the gabriel/txm-transaction-callbacks branch from 3f8de75 to 3bf00b1 Compare May 12, 2025 10:41

norswap reviewed May 16, 2025

View reviewed changes

norswap approved these changes May 16, 2025

View reviewed changes

norswap added merge-after-changes Can be merged after requested changes are made and removed reviewing-2 Ready for, or undergoing final review labels May 16, 2025

GabrielMartinezRodriguez added 3 commits May 21, 2025 10:48

feat(txm): added txm callbacks and promises when tx status change

e3a8937

feat(txm): implemented timeout mechanism for waitForFinalization

a61e32b

chore: format

40a224e

GabrielMartinezRodriguez force-pushed the gabriel/txm-transaction-callbacks branch from 3bf00b1 to 40a224e Compare May 21, 2025 08:56

chore(txm): pr review

e5b67a8

GabrielMartinezRodriguez merged commit 947f008 into master May 21, 2025
4 checks passed

GabrielMartinezRodriguez deleted the gabriel/txm-transaction-callbacks branch May 21, 2025 09:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(txm): added txm callbacks and promises when tx status change#719

feat(txm): added txm callbacks and promises when tx status change#719
GabrielMartinezRodriguez merged 4 commits intomasterfrom
gabriel/txm-transaction-callbacks

GabrielMartinezRodriguez commented May 5, 2025 •

edited

Loading

Uh oh!

cloudflare-workers-and-pages bot commented May 5, 2025 •

edited

Loading

Uh oh!

GabrielMartinezRodriguez commented May 5, 2025 •

edited

Loading

Uh oh!

linear bot commented May 5, 2025

Uh oh!

aodhgan May 8, 2025

Uh oh!

aodhgan May 8, 2025

Uh oh!

aodhgan May 8, 2025

Uh oh!

aodhgan May 8, 2025

Uh oh!

norswap May 16, 2025 •

edited

Loading

Uh oh!

aodhgan May 8, 2025

Uh oh!

norswap May 16, 2025

Uh oh!

norswap May 16, 2025

Uh oh!

GabrielMartinezRodriguez May 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

GabrielMartinezRodriguez commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Linked Issues

Description

Checklist

Basics

Correctness

Architecture & Documentation

Uh oh!

cloudflare-workers-and-pages bot commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying happychain with Cloudflare Pages

Uh oh!

GabrielMartinezRodriguez commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear bot commented May 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

norswap May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GabrielMartinezRodriguez commented May 5, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented May 5, 2025 •

edited

Loading

GabrielMartinezRodriguez commented May 5, 2025 •

edited

Loading

norswap May 16, 2025 •

edited

Loading